/**
 * Copyright 2006 gworks.com.au
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. (http://www.apache.org/licenses/LICENSE-2.0)
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed 
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for 
 * the specific language governing permissions and limitations under the License.
 *
 * <dhamma-message src="Atisha (11th century Tibetan Buddhist master)">
 * 	The greatest achievement is selflessness. The greatest worth is self-mastery.
 * 	The greatest quality is seeking to serve others. The greatest precept is continual awareness.
 * 	The greatest medicine is the emptiness of everything. The greatest action is not conforming with the worlds ways.
 * 	The greatest magic is transmuting the passions. The greatest generosity is non-attachment.
 * 	The greatest goodness is a peaceful mind. The greatest patience is humility.
 * 	The greatest effort is not concerned with results. The greatest meditation is a mind that lets go.
 * 	The greatest wisdom is seeing through appearances. 
 * </dhamma-message>
 */
package org.javaongems.client.forms;

import org.javaongems.client.rt.io.AsyncCallbackFilter;

import com.google.gwt.user.client.rpc.AsyncCallback;

/**
 * <p>Provides the ability to wrap all async callbacks with form status 
 * reporting decorations.</p>
 * <p>Responsibilities:
 * <ul>
 * 	<li> send report load status message to form
 *  <li> send close loading status report to form on callback completion
 *  	 (ie. either success or failure) 
 * </ul>
 * </p>
 * <p>Collaborators:
 * <ul>
 *  <li> Gem#stone.decorateAsyncCallback() - origins
 * 	<li> {@link Form} - display
 * </ul>
 * </p>
 * @author Ashin Wimalajeewa (ash)
 */
public class FormLoadStatusCallback extends AsyncCallbackFilter {
	final static public String HNDL = "form-load-status"; 
	protected Form form;
	
	public FormLoadStatusCallback(Form form, AsyncCallback toWrap) {
		super(toWrap);
		setForm(form);
	}
	
	public String getHandle() {
		return HNDL;
	}

	public Form getForm() {
		return form;
	}
	
	public void setForm(Form frm) {
		form = frm;
	}
	
	public void setStatus(String msg) {
		form.reportLoadingStatus(msg);
	}
	
	public void onFailure(Throwable caught) {
		super.onFailure(caught);
		if (form != null)
			form.closeLoadingStatusReport();
	}

	public void onSuccess(Object result) {
		super.onSuccess(result);
		if (form != null)
			form.closeLoadingStatusReport();
	}
}
